Repository navigation
Conversation
cgl
reviewed
Nov 20, 2026
| @@ -0,0 +1,17 @@ | |||
| {% set groups = [ | |||
| ('Init', [('README', 'Introduction'), ('INSTALLATION', 'Installation')]), | |||
Collaborator
There was a problem hiding this comment.
🤔 What could be an alternative to Init? It reads a bit different to me.
Author
There was a problem hiding this comment.
What about Getting started ? This would cover the installation and the introduction.
| ## Contribution | ||
|
|
||
| See [Contributing](CONTRIBUTING.md) to get involved. | ||
| See [Contributing](https://www.encode.io/hip/contributing/) to get involved. |
Collaborator
There was a problem hiding this comment.
♻️ Maybe keep the links internal?
Author
There was a problem hiding this comment.
I used absolute URLs because this README is also used as the PyPI description where relative links would not point to the documentation.
| pip install hip | ||
| ``` | ||
|
|
||
| See the [installation guide](https://www.encode.io/hip/installation/) for more options. |
Member
|
Woah, this is really neat to see, thank you! 😄 (I'm going to need a little bit of time to take this in properly.) |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The API documentation currently puts client, server, and shared models on one page. This change separates them into Client, Server and Core, with grouped navigation and worked examples.
Updated README, added proper installation, usage examples. We now have test and version badges. Links and image URL are absolute so they work in the PyPI package description. (see #74 )
The install guide now lists
Python 3.11as the minimum version. and shows how to check the installed hip version. After #147 , I also updated the timeout examples to usehip.backends.timeout().I kept the theme, just modified the fonts, spacing and layout.
The docs build works properly, and local links and anchors work. I also tried the examples in a separate project with
hip 0.4from main.The HEAD example is kept from the existing docs and depends on #132 .
#108 also updates the Content docs. The additions might have to go to the new Core page.
Referance #145